何謂註解

我想大家對註解的定義也不陌生，其實就像我們小時候像學習文言文一樣，

我們會把這個字的意思詳述在旁邊，那就像是我們對這個字或這句話加以描述。

程式語言也不例外，擁有了註解，我們可以解釋我們的程式碼，而且註解在程式碼當中是不會執行的區段。

為何需要使用註解

註解的重要性就像我說的，在程式碼中這段其實並不會執行，

但可以讓我們快速理解這段程式碼在寫什麼，可能有人會問，那如果我程式寫得很好呢？

那這樣註解有它存在的必要性嗎？

其實我覺得當時間一久了，如果經過了好幾年，或許有所成長，

後來再回來看自己寫的程式碼，或許需要花一段時間想當初在幹嘛。

但這時如果有了註解，或許就可以快速找回記憶的片段。

另外，我想未必每個人都會在同一份工作做個二三十年，當要離開這份工作崗位的時候，

或許你的主管會希望你留下註解，讓未來接手的工程師能快速了解當初這些的目的性，

但如果平常就以註解做這件事的話，這樣也省去可能經過好幾年，然後你再回來思考當初在做什麼的時間。

當然我也相信如果程式碼簡單到一眼就看出來寫的人想要表達什麼，那當然註解就不一定是必要的。

畢竟註解是讓我們更快速理解這段的用意為何。

Ruby註解呈現方式

究竟如何在Ruby裡面以註解的方式呈現呢？我們會以#(井字號)做為單行註解的開始。

例如：

#這是一個註解

然而如果這個註解的字可能很長我們會藉由=begin … =end，這區塊內為一個多行註解。

例如：

=begin

嘿！注意

這裡是一段註解

請仔細閱讀

=end

會藉由 =begin開頭，然後把註解寫入，最後以=end做為結尾。

Day 5 結語

未來的我，不只想成為一個寫出程式碼的人，我會更想讓大家都能理解我在做什麼。

我相信註解未來覺得是我不可或缺的好夥伴，畢竟未來的路是跟同事一起做專案，

是充滿滿滿的合作，相互學習的道路上，而不是獨自一人完成所有。